home *** CD-ROM | disk | FTP | other *** search
/ Sprite 1984 - 1993 / Sprite 1984 - 1993.iso / man / lib / tk / GetFontStr.man < prev    next >
Encoding:
Text File  |  1992-08-24  |  6.6 KB  |  257 lines
  1. '\"
  2. '\" Copyright 1990, 1991, 1992 Regents of the University of California
  3. '\" Permission to use, copy, modify, and distribute this
  4. '\" documentation for any purpose and without fee is hereby
  5. '\" granted, provided that this notice appears in all copies.
  6. '\" The University of California makes no representations about
  7. '\" the suitability of this material for any purpose.  It is
  8. '\" provided "as is" without express or implied warranty.
  9. '\" 
  10. '\" $Header: /user6/ouster/wish/man/RCS/GetFontStr.man,v 1.4 92/01/02 09:09:49 ouster Exp $ SPRITE (Berkeley)
  11. '\" 
  12. .\" The definitions below are for supplemental macros used in Sprite
  13. .\" manual entries.
  14. .\"
  15. .\" .HS name section [date [version]]
  16. .\"    Replacement for .TH in other man pages.  See below for valid
  17. .\"    section names.
  18. .\"
  19. .\" .AP type name in/out [indent]
  20. .\"    Start paragraph describing an argument to a library procedure.
  21. .\"    type is type of argument (int, etc.), in/out is either "in", "out",
  22. .\"    or "in/out" to describe whether procedure reads or modifies arg,
  23. .\"    and indent is equivalent to second arg of .IP (shouldn't ever be
  24. .\"    needed;  use .AS below instead)
  25. .\"
  26. .\" .AS [type [name]]
  27. .\"    Give maximum sizes of arguments for setting tab stops.  Type and
  28. .\"    name are examples of largest possible arguments that will be passed
  29. .\"    to .AP later.  If args are omitted, default tab stops are used.
  30. .\"
  31. .\" .BS
  32. .\"    Start box enclosure.  From here until next .BE, everything will be
  33. .\"    enclosed in one large box.
  34. .\"
  35. .\" .BE
  36. .\"    End of box enclosure.
  37. .\"
  38. .\" .VS
  39. .\"    Begin vertical sidebar, for use in marking newly-changed parts
  40. .\"    of man pages.
  41. .\"
  42. .\" .VE
  43. .\"    End of vertical sidebar.
  44. .\"
  45. .\" .DS
  46. .\"    Begin an indented unfilled display.
  47. .\"
  48. .\" .DE
  49. .\"    End of indented unfilled display.
  50. .\"
  51. '\"    # Heading for Sprite man pages
  52. .de HS
  53. .if '\\$2'cmds'       .TH \\$1 1 \\$3 \\$4
  54. .if '\\$2'lib'        .TH \\$1 3 \\$3 \\$4
  55. .if '\\$2'tcl'        .TH \\$1 3 \\$3 \\$4
  56. .if '\\$2'tk'         .TH \\$1 3 \\$3 \\$4
  57. .if t .wh -1.3i ^B
  58. .nr ^l \\n(.l
  59. .ad b
  60. ..
  61. '\"    # Start an argument description
  62. .de AP
  63. .ie !"\\$4"" .TP \\$4
  64. .el \{\
  65. .   ie !"\\$2"" .TP \\n()Cu
  66. .   el          .TP 15
  67. .\}
  68. .ie !"\\$3"" \{\
  69. .ta \\n()Au \\n()Bu
  70. \&\\$1    \\fI\\$2\\fP    (\\$3)
  71. .\".b
  72. .\}
  73. .el \{\
  74. .br
  75. .ie !"\\$2"" \{\
  76. \&\\$1    \\fI\\$2\\fP
  77. .\}
  78. .el \{\
  79. \&\\fI\\$1\\fP
  80. .\}
  81. .\}
  82. ..
  83. '\"    # define tabbing values for .AP
  84. .de AS
  85. .nr )A 10n
  86. .if !"\\$1"" .nr )A \\w'\\$1'u+3n
  87. .nr )B \\n()Au+15n
  88. .\"
  89. .if !"\\$2"" .nr )B \\w'\\$2'u+\\n()Au+3n
  90. .nr )C \\n()Bu+\\w'(in/out)'u+2n
  91. ..
  92. '\"    # BS - start boxed text
  93. '\"    # ^y = starting y location
  94. '\"    # ^b = 1
  95. .de BS
  96. .br
  97. .mk ^y
  98. .nr ^b 1u
  99. .if n .nf
  100. .if n .ti 0
  101. .if n \l'\\n(.lu\(ul'
  102. .if n .fi
  103. ..
  104. '\"    # BE - end boxed text (draw box now)
  105. .de BE
  106. .nf
  107. .ti 0
  108. .mk ^t
  109. .ie n \l'\\n(^lu\(ul'
  110. .el \{\
  111. .\"    Draw four-sided box normally, but don't draw top of
  112. .\"    box if the box started on an earlier page.
  113. .ie !\\n(^b-1 \{\
  114. \h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul'
  115. .\}
  116. .el \}\
  117. \h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul'
  118. .\}
  119. .\}
  120. .fi
  121. .br
  122. .nr ^b 0
  123. ..
  124. '\"    # VS - start vertical sidebar
  125. '\"    # ^Y = starting y location
  126. '\"    # ^v = 1 (for troff;  for nroff this doesn't matter)
  127. .de VS
  128. .mk ^Y
  129. .ie n 'mc \s12\(br\s0
  130. .el .nr ^v 1u
  131. ..
  132. '\"    # VE - end of vertical sidebar
  133. .de VE
  134. .ie n 'mc
  135. .el \{\
  136. .ev 2
  137. .nf
  138. .ti 0
  139. .mk ^t
  140. \h'|\\n(^lu+3n'\L'|\\n(^Yu-1v\(bv'\v'\\n(^tu+1v-\\n(^Yu'\h'-|\\n(^lu+3n'
  141. .sp -1
  142. .fi
  143. .ev
  144. .\}
  145. .nr ^v 0
  146. ..
  147. '\"    # Special macro to handle page bottom:  finish off current
  148. '\"    # box/sidebar if in box/sidebar mode, then invoked standard
  149. '\"    # page bottom macro.
  150. .de ^B
  151. .ev 2
  152. 'ti 0
  153. 'nf
  154. .mk ^t
  155. .if \\n(^b \{\
  156. .\"    Draw three-sided box if this is the box's first page,
  157. .\"    draw two sides but no top otherwise.
  158. .ie !\\n(^b-1 \h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c
  159. .el \h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c
  160. .\}
  161. .if \\n(^v \{\
  162. .nr ^x \\n(^tu+1v-\\n(^Yu
  163. \kx\h'-\\nxu'\h'|\\n(^lu+3n'\ky\L'-\\n(^xu'\v'\\n(^xu'\h'|0u'\c
  164. .\}
  165. .bp
  166. 'fi
  167. .ev
  168. .if \\n(^b \{\
  169. .mk ^y
  170. .nr ^b 2
  171. .\}
  172. .if \\n(^v \{\
  173. .mk ^Y
  174. .\}
  175. ..
  176. '\"    # DS - begin display
  177. .de DS
  178. .RS
  179. .nf
  180. .sp
  181. ..
  182. '\"    # DE - end display
  183. .de DE
  184. .fi
  185. .RE
  186. .sp .5
  187. ..
  188. .HS Tk_GetFontStruct tk
  189. .BS
  190. .SH NAME
  191. Tk_GetFontStruct, Tk_NameOfFontStruct, Tk_FreeFontStruct \- maintain database of fonts
  192. .SH SYNOPSIS
  193. .nf
  194. \fB#include <tk.h>\fR
  195. .sp
  196. XFontStruct *
  197. \fBTk_GetFontStruct(\fIinterp, tkwin, nameId\fB)\fR
  198. .sp
  199. char *
  200. \fBTk_NameOfFontStruct(\fIfontStructPtr\fB)\fR
  201. .sp
  202. \fBTk_FreeFontStruct(\fIfontStructPtr\fB)\fR
  203. .SH ARGUMENTS
  204. .AS "XFontStruct" *fontStructPtr
  205. .AP Tcl_Interp *interp in
  206. Interpreter to use for error reporting.
  207. .AP Tk_Window tkwin in
  208. Token for window in which font will be used.
  209. .AP Tk_Uid nameId in
  210. Name of desired font.
  211. .AP XFontStruct *fontStructPtr in
  212. Font structure to return name for or delete.
  213. .BE
  214.  
  215. .SH DESCRIPTION
  216. .PP
  217. \fBTk_GetFont\fR loads the font indicated
  218. by \fInameId\fR and returns a pointer to information about the
  219. font.  The pointer returned by \fBTk_GetFont\fR
  220. will remain valid until \fBTk_FreeFont\fR
  221. is called to release it.
  222. \fINameId\fR can be either a font name or pattern;  any
  223. value that could be passed to \fBXLoadQueryFont\fR may be
  224. passed to \fBTk_GetFont\fR.  If \fBTk_GetFont\fR is unsuccessful
  225. (because, for example, there is no font corresponding to
  226. \fInameId\fR) then it returns \fBNULL\fR and stores an error
  227. message in \fIinterp->result\fR.
  228. .PP
  229. \fBTk_GetFont\fR maintains a database of all fonts it has allocated.
  230. If the same \fInameId\fR is requested multiple times (e.g. by
  231. different windows or for different purposes), then additional
  232. calls for the same \fInameId\fR will be handled very quickly, without
  233. involving the X server.  For this reason, it is generally better
  234. to use \fBTk_GetFont\fR in place of X library procedures like
  235. \fBXLoadQueryFont\fR.
  236. .PP
  237. The procedure \fBTk_NameOfFontStruct\fR is roughly the inverse of
  238. \fBTk_GetFontStruct\fR.  If its \fIfontStructPtr\fR argument was created
  239. by \fBTk_GetFontStruct\fR, then the return value is the \fInameId\fR
  240. argument that was passed to \fBTk_GetFontStruct\fR to create the
  241. font.  If \fIfontStructPtr\fR was not created by a call
  242. to \fBTk_GetFontStruct\fR, then the return value is a hexadecimal string
  243. giving the X identifier for the associated font.
  244. Note:  the string returned by \fBTk_NameOfFontStruct\fR is
  245. only guaranteed to persist until the next call to \fBTk_NameOfFontStruct\fR.
  246. .PP
  247. When a font returned by \fBTk_GetFont\fR is no longer
  248. needed, \fBTk_FreeFont\fR should be called to release it.
  249. There should be exactly one call to \fBTk_FreeFont\fR for
  250. each call to \fBTk_GetFont\fR.  When a font is no longer in
  251. use anywhere (i.e. it has been freed as many times as it has been gotten)
  252. \fBTk_FreeFont\fR will release it to the X server and delete it from
  253. the database.
  254.  
  255. .SH KEYWORDS
  256. font
  257.